home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1997 October / macformat-055.iso / mac / Shareware Plus / Applications / Super Countdown / Super Countdown & Frontier / DocServer Source Text next >
Encoding:
Text File  |  1997-03-25  |  3.2 KB  |  90 lines  |  [TEXT/DOCS]
  1.  
  2. Verb    superCountdown.bringToFront
  3. Syntax    superCountdown.bringToFront ()
  4. Parameters    None.
  5. Action    Brings the Super Countdown application to the front. Launches it if neccessary.
  6. Returns    True.
  7. Examples    superCountdown.bringToFront ()
  8.     » true
  9. Notes    None.
  10. See Also    superCountdown.launch
  11.  
  12. Verb    superCountdown.launch
  13. Syntax    superCountdown.launch ()
  14. Parameters    None.
  15. Action    Launches Super Countdown.
  16. Returns    True.
  17. Examples    superCountdown.launch ()
  18.     » true
  19. Notes    None.
  20. See Also    superCountdown.isRunning
  21. superCountdown.quit
  22. superCountdown.bringToFront
  23.  
  24. Verb    superCountdown.isRunning
  25. Syntax    superCountdown.isRunning ()
  26. Parameters    None.
  27. Action    Queries as to whether or not Super Countdown is currently running.
  28. Returns    True is it is running, false if it isn't.
  29. Examples    superCountdown.isRunning ()
  30.     » true
  31. Notes    None.
  32. See Also    superCountdown.launch
  33. superCountdown.quit
  34. superCountdown.bringToFront
  35.  
  36. Verb    superCountdown.quit
  37. Syntax    superCountdown.quit ()
  38. Parameters    None.
  39. Action    Quits Super Countdown.
  40. Returns    True.
  41. Examples    superCountdown.quit ()
  42.     » true
  43. Notes    None.
  44. See Also    superCountdown.isRunning
  45. superCountdown.launch
  46.  
  47. Verb    superCountdown.settime
  48. Syntax    superCountdown.quit ( seconds )
  49. Parameters    seconds is how many seconds you want to set the timer for. Must be an integer between zero and 36,000.
  50. Action    Sets the timer to the specified number of seconds.
  51. Returns    True is successful. Look at the file included with the Super Countdown distribution called "Result Codes for Events" for other possibilities.
  52. Examples    superCountdown.settime ( "120" )
  53.     » true «the timer has been set to 2 minutes
  54. Notes    This will only work if the timer is in countdown mode. This is the default mode for new windows and when the application launches.
  55. See Also    superCountdown.start
  56. superCountdown.stop
  57.  
  58. Verb    superCountdown.start
  59. Syntax    superCountdown.start ()
  60. Parameters    None.
  61. Action    Starts the timer.
  62. Returns    True is successful. Look at the file included with the Super Countdown distribution called "Result Codes for Events" for other possibilities.
  63. Examples    superCountdown.start ()
  64.     » true
  65. Notes    If the timer is in countdown mode a time needs to be set first. If the timer is in countup mode, it will resume from the current time on the display.
  66. See Also    superCountdown.settime
  67. superCountdown.stop
  68. superCountdown.timeleft
  69.  
  70. Verb    superCountdown.stop
  71. Syntax    superCountdown.stop ()
  72. Parameters    None.
  73. Action    Stops the timer.
  74. Returns    True is successful. Look at the file included with the Super Countdown distribution called "Result Codes for Events" for other possibilities.
  75. Examples    superCountdown.stop ()
  76.     » true
  77. Notes    Timer must already be running for this to work.
  78. See Also    superCountdown.start
  79. superCountdown.timeleft
  80.  
  81. Verb    superCountdown.timeleft
  82. Syntax    superCountdown.timeleft ()
  83. Parameters    None.
  84. Action    Asks the timer what the current time is on the display.
  85. Returns    The displayed time in seconds. Look at the file included with the Super Countdown distribution called "Result Codes for Events" for other possibilities.
  86. Examples    superCountdown.timeleft ()
  87.     » 121 «the timer currently reads 2 minutes and 1 second.
  88. Notes    You don't have to be in countdown mode for this to work. It will also return the displayed time in countup mode.
  89. See Also    superCountdown.settime
  90.